Read(Byte[],Int32,Int32) Method

Reads at least one byte of data from the stream and copies it into the provided buffer.

[Visual Basic]
Overloads Overrides Public Function Read( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal size As Integer _
) As Integer

[C#]
public override int Read( 
   byte[] buffer,
   int offset,
   int size
);

[C++]
public: int Read( 
   byte[]* buffer,
   int offset,
   int size
) override 

[C++/CLI]
public:
int Read( 
   bytearray<buffer>^ buffer,
   int offset,
   int size
) override 

Parameters

buffer

The storage location for the received data.

offset

The zero-based position in the buffer at which to store the received data.

size

The maximum number of bytes to read.

Return Type

The total number of bytes read into the buffer.

Exceptions

Remarks

This is the standard method to use when reading a stream synchronously.

The return value may be less than the number of bytes requested if that many bytes are not currently available, or zero if the end of the stream has been reached. Applications must check this value to know how many bytes were read into the buffer.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

TcpStream Class  | TcpStream Members  | Overload List